Update PrinciplesReviewWorkflow.md for clarity and fix typos #2435
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
nataled
added
documentation
nlharris
approved these changes
Sep 14, 2023
docs/PrinciplesReviewWorkflow.md
Outdated
|
|
||
| - Discuss the principle on working group call | ||
| - Discuss the principle during a working group call |
There was a problem hiding this comment.
maybe make "working group" more explicit as Editorial WG
docs/PrinciplesReviewWorkflow.md
Outdated
|
|
||
| - Discuss the principle on working group call | ||
| - Discuss the principle during a working group call | ||
| - Write up proposed revisions as a GitHub issue (not a pull request) | ||
| - Inform the Editorial WG via email that the ticket needs discussion (if it doesn’t happen automatically) |
There was a problem hiding this comment.
If what doesn't happen automatically? The informing, or the discussing?
There was a problem hiding this comment.
At the time this was written, it wasn't clear if there was some automatic message sent to members. Since it is now clear that this does not happen, I removed the phrase.
docs/PrinciplesReviewWorkflow.md
Outdated
|
|
||
| - Discuss the principle on working group call | ||
| - Discuss the principle during a working group call | ||
| - Write up proposed revisions as a GitHub issue (not a pull request) |
docs/PrinciplesReviewWorkflow.md
Outdated
| - Write up proposed revisions as a GitHub issue (not a pull request) | ||
| - Inform the Editorial WG via email that the ticket needs discussion (if it doesn’t happen automatically) | ||
| - Two-week commenting period on GitHub issue tracker | ||
| - Two-week commenting period on the GitHub issue tracker | ||
| - Make any incremental improvements on the tracker |
There was a problem hiding this comment.
Who makes what improvements? This needs clarification
docs/PrinciplesReviewWorkflow.md
Outdated
| - Make any incremental improvements on the tracker | ||
| - When the Editorial WG agrees on a final version, discuss on an Operations Committee call or via the issue tracke | ||
| - When the Editorial WG agrees on a final version, discuss on an Operations Committee call or via the issue tracker | ||
| - Make a pull request |
docs/PrinciplesReviewWorkflow.md
Outdated
| - Make a pull request | ||
| - Two-week commenting period on the pull request | ||
| - Upload final changes to OBO Foundry web site for public viewing. | ||
| - Upload final changes to OBO Foundry web site for public viewing |
There was a problem hiding this comment.
Actually, no one. It's merely linked from elsewhere. I clarified the procedure.
Addresses Nomi's suggestions and fleshes out some steps.
|
Looks like I didn't get here in time. Apologies. If you still would like me to review it please let me know. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.